온나라2.0 연계 서비스
ONNARA 2.0 Service
1. 개요
-
온나라 DRM 연계를 위한 문서로, 문서보안 인터페이스 API, 에러코드를 담고 있다.
-
문서보안 인터페이스는 REST API 로 구현 되어 있다.
REST API 메소드, CRUD, SQL 비교
REST API 전송 방식
여기 요청하신 문서를 Markdown 형식으로 변환한 내용입니다:
2. 문서 암호화 API
암호화 대상 파일 정보를 받아 해당 파일을 암호화 하고 암호화 된 파일의 경로를 반환한다.
2.1. 기본정보
| 항목 | 내용 |
|---|---|
| Resource URI | http://{serverip:port}/SCONNARA/api/encrypt |
| HTTP Method | POST |
| Request Header | Content-Type : application/json; charset=UTF-8 |
| Response Header | Content-Type : application/json; charset=UTF-8 |
2.2. 요청 파라미터 정보 (JSON)
| 파라미터명 | 필수값 | 타입 | 예제값 | 설명 |
|---|---|---|---|---|
| insttCode | Y | String | 1740000 | 기관코드 |
| userId | Y | String | hyhan | 온-나라 시스템 로그인 ID |
| filePath | Y | String | /tmp/3DE333SDF/5212.hwp | 암호화 대상 파일 경로 |
| systemId | String | BMS | 시스템 ID | |
| processId | String | DCT | 온-나라 시스템 업무영역 코드 전자문서 : DCT 메모보고 : MEM 기타 : ETC | |
| actionType | String | APPROVAL | 수행업무 분류명 기안 : DRAFT 결재 : APPROVAL | |
| isOpen | Boolean | true | 파일 공개 여부 공개 : true 비공개 : false | |
| docId | String | DCT74DC6AEE150DC07631F | 온-나라시스템 업무단위 식별 ID | |
| fileId | String | 3D23LDK23D2JK3DLK2 | 암호화 대상파일 고유 식별 ID |
2.2.1 요청 메시지 예시
[
{
"insttCode": "1740000",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_dec1.csv"
},
{
"insttCode": "1740001",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_dec2.csv"
}
]
2.2.2 전송 흐름
온나라 → 웹서버
2.3. 응답 파라미터 정보 (JSON)
| 엘리먼트명 | 타입 | 예제값 | 설명 |
|---|---|---|---|
| status | String | ok | 서비스 결과 상태 성공 : ok 실패 : error |
| data | Object | 정상처리 결과 데이터 목록 | |
| insttCode | String | 1740000 | 기관코드 |
| userId | String | hyhan | 온-나라 시스템 로그인 ID |
| filePath | String | /tmp/3DE333SDF/5212.hwp | 암호화 대상 파일 경로 |
| error | Object | 에러처리 결과 데이터 목록 | |
| code | String | FILE_NOT_FOUND | 에러코드 |
| message | String | 파일이 존재하지 않습니다. | 에러코드 메시지 |
2.3.1 에러처리 응답 메시지 예시
{
"status": "error",
"error": {
"code": "FILE_NOT_FOUND",
"message": "파일이 존재하지 않습니다."
}
}
- 보안 문서 암호화 시 재암호화 후 정본 전문 전송
- 다수 파일 중 하나라도 실패 시 실패 전문 전송
- 에러 코드는 참고 슬라이드 참조
2.3.2. 정상처리 응답 메시지 예시
{
"status": "ok",
"data": [
{
"insttCode": "1740000",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_dec1.csv"
},
{
"insttCode": "1740001",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_dec2.csv"
}
]
}
2.3.3. 전송 흐름
웹서버 → 온나라
3. 문서 복호화 API
복호화 대상 파일 정보를 받아 해당 파일을 복호화 하고 복호화 된 파일의 경로를 반환한다.
3.1. 기본정보
| 항목 | 내용 |
|---|---|
| Resource URI | http://{serverip:port}/SCONNARA/api/decrypt |
| HTTP Method | POST |
| Request Header | Content-Type : application/json; charset=UTF-8 |
| Response Header | Content-Type : application/json; charset=UTF-8 |
3.2. 요청 파라미터 정보 (JSON)
| 파라미터명 | 필수값 | 타입 | 예제값 | 설명 |
|---|---|---|---|---|
| insttCode | Y | String | 1740000 | 기관코드 |
| userId | Y | String | hyhan | 온-나라 시스템 로그인 ID |
| filePath | Y | String | /tmp/3DE333SDF/5212.hwp | 복호화 대상 파일 경로 |
| systemId | String | BMS | 시스템 ID | |
| processId | String | DCT | 온-나라 시스템 업무영역 코드 전자문서 : DCT 메모보고 : MEM 기타 : ETC | |
| actionType | String | APPROVAL | 수행업무 분류명 기안 : DRAFT 결재 : APPROVAL | |
| isOpen | Boolean | true | 파일 공개 여부 공개 : true 비공개 : false | |
| docId | String | DCT74DC6AEE150DC07631F | 온-나라시스템 업무단위 식별 ID | |
| fileId | String | 3D23LDK23D2JK3DLK2 | 복호화 대상파일 고유 식별 ID |
3.2.1 요청 메시지 예시
[
{
"insttCode": "1740000",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_dec1.csv"
},
{
"insttCode": "1740001",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_enc1.csv"
}
]
3.2.2 전송 흐름
온나라 → 웹서버
3.3. 응답 파라미터 정보 (JSON)
| 엘리먼트명 | 타입 | 예제값 | 설명 |
|---|---|---|---|
| status | String | ok | 서비스 결과 상태 성공 : ok 실패 : error |
| data | Object | 정상처리 결과 데이터 목록 | |
| insttCode | String | 1740000 | 기관코드 |
| userId | String | hyhan | 온-나라 시스템 로그인 ID |
| filePath | String | /tmp/3DE333SDF/5212.hwp | 복호화 대상 파일 경로 |
| error | Object | 에러처리 결과 데이터 목록 | |
| code | String | FILE_NOT_FOUND | 에러코드 |
| message | String | 파일이 존재하지 않습니다. | 에러코드 메시지 |
3.3.1 에러처리 응답 메시지 예시
{
"status": "error",
"error": {
"code": "FILE_NOT_FOUND",
"message": "파일이 존재하지 않습니다."
}
}
- 일반 문서 복호화 시 성공 전문 전송
- 다수 파일 중 하나라도 실패 시 실패 전문 전송
- 에러 코드는 참고 슬라이드 참조
3.3.2 정상처리 응답 메시지 예시
{
"status": "ok",
"data": [
{
"insttCode": "1740000",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_dec1.csv"
},
{
"insttCode": "1740001",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_enc1.csv"
}
]
}
3.3.3 전송 흐름
웹서버 → 온나라
4. 암호화 여부 확인 API
확인 대상 파일 정보를 받아 해당 파일이 암호화 된 파일인지 여부를 반환한다.
4.1. 기본정보
| 항목 | 내용 |
|---|---|
| Resource URI | http://{serverip:port}/SCONNARA/api/retrieve |
| HTTP Method | POST |
| Request Header | Content-Type : application/json; charset=UTF-8 |
| Response Header | Content-Type : application/json; charset=UTF-8 |
4.2. 요청 파라미터 정보 (JSON)
| 파라미터명 | 필수값 | 타입 | 예제값 | 설명 |
|---|---|---|---|---|
| insttCode | Y | String | 1740000 | 기관코드 |
| userId | Y | String | hyhan | 온-나라 시스템 로그인 ID |
| filePath | Y | String | /tmp/3DE333SDF/5212.hwp | 복호화 대상 파일 경로 |
| processId | String | DCT | 온-나라 시스템 업무영역 코드 전자문서 : DCT 메모보고 : MEM 기타 : ETC | |
| actionType | String | APPROVAL | 수행업무 분류명 기안 : DRAFT 결재 : APPROVAL | |
| docId | String | DCT74DC6AEE150DC07631F | 온-나라시스템 업무단위 식별 ID |
4.2.1 요청 메시지 예시
[
{
"insttCode": "1740000",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_dec1.csv",
"processId": "DCT",
"actionType": "APPROVAL",
"docId": "DCT74DC6AEE150DC07631FFFFF804E4041"
},
{
"insttCode": "1740001",
"userId": "hyhan",
"filePath": "/APP/SCONNARA2/data/temp/test_enc2.csv",
"processId": "DCT",
"actionType": "APPROVAL",
"docId": "DCT74DC6AEE150DC07631FFFFF804E4042"
}
]
4.2.2 전송 흐름
온나라 → 웹서버
4.3. 응답 파라미터 정보 (JSON)
| 엘리먼트명 | 타입 | 예제값 | 설명 |
|---|---|---|---|
| status | String | ok | 서비스 결과 상태 성공 : ok 실패 : error |
| data | Object | 정상처리 결과 데이터 목록 | |
| isSecure | Boolean | true | 암호화 문서 : true 일반 문서 : false |
| isRegisterable | Boolean | true | 고정값 : true |
| insttCode | String | 1740000 | 기관코드 |
| processId | String | DCT | 업무영역 코드 전자 문서 : DCT 메모 보고 : MEM 기타 : ETC |
| actionType | String | APPROVAL | 수행업무 분류명 기안 : DRAFT 결재 : APPROVAL |
| userId | String | hyhan | 문서 암호화 사용자 ID |
| docId | String | DCT74DC6AEE150DC07631FF | 업무단위 식별 ID |
| error | Object | 에러처리 결과 데이터 목록 | |
| code | String | FILE_NOT_FOUND | 에러코드 |
| message | String | 파일이 존재하지 않습니다. | 에러코드 메시지 |
4.3.1 정상처리 응답 메시지 예시
암호화 문서, 일반 문서 섞여 있는 경우
{
"status": "ok",
"data": [
{
"isSecure": false,
"isRegisterable": true
},
{
"insttCode": "1740001",
"processId": "DCT",
"actionType": "APPROVAL",
"userId": "hyhan",
"docId": "DCT74DC6AEE150DC07631FFFFF804E4042",
"isSecure": true,
"isRegisterable": true
}
]
}
4.3.2 에러처리 응답 메시지 예시
{
"status": "error",
"error": {
"code": "FILE_NOT_FOUND",
"message": "파일이 존재하지 않습니다."
}
}
- 다수 파일 중 하나라도 실패 시 실패 전문 전송
- 에러 코드는 참고 슬라이드 참조
4.3.3 전송 흐름
웹서버 → 온나라